home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 008 / mandbrot.arc / MANDBROT.DOC < prev    next >
Encoding:
Text File  |  1987-07-22  |  12.9 KB  |  250 lines

  1.                     MANDBROT PROGRAM DOCUMENTATION
  2.                     ------------------------------
  3.  
  4.  
  5.     Execute the file MANDBROT.EXE.  You will first be prompted for
  6.     the type of video display that you have.  Enter an E if you have
  7.     a color EGA display with at least 128K of video RAM, or a C if
  8.     you have a CGA display.  You do not have to enter a carriage
  9.     return when you enter the display type.If you don't have one of
  10.     these displays, you are out of luck.  If you have a CGA display,
  11.     the program runs in the hi-res two color mode.  You will not see
  12.     very impressive displays, but you can get an idea of what the
  13.     Mandelbrot displays look like.  Also, the CGA mode does not have
  14.     all the features that the EGA mode has.  Also the CGA mode may
  15.     produce errors if features which are really only supported in EGA
  16.     mode are used.  Sorry, I did not want to spend much time supporting
  17.     CGA.
  18.  
  19.     Next, if you have an EGA display, you will be asked if you want
  20.     to load a previously saved picture from disk.  Enter a Y or N.
  21.     You will not have to enter a carriage return.  The picture is
  22.     loaded VERY FAST.  This is because BIOS routines are not used.
  23.     The picture is loaded directly into the EGA RAM, so it only
  24.     takes about 4 seconds to load a picture from a hard disk.  It
  25.     takes a few seconds longer from a floppy disk.
  26.  
  27.     If you entered a Y for the previous prompt, you will be asked to
  28.     enter the filename for the saved picture.  Enter the filename, but
  29.     DO NOT enter the extension.  When you enter a carriage return, the
  30.     file will be loaded and displayed.
  31.  
  32.     If you answered N for loading a picture, you will next be prompted
  33.     as to whether you want curvetrace or not.  Curvetrace is a method
  34.     used to greatly speed up the Mandelbrot computation process.  It
  35.     is one feature of this program that distinguishes it from all the
  36.     other Mandelbrot programs you may have tried.  It is possible
  37.     (although rare) that the curvetrace may not produce an exact
  38.     representation of the Mandelbrot set.  This is why it is an option.
  39.  
  40.     Next you will be prompted for the maximum number of iterations to
  41.     use in the computations.  Enter a number from 25 to 1000.  This
  42.     number affects both the computation speed and the color distribution
  43.     of the result.  You will have to experiment.  In general, use low
  44.     counts if you are not zoomed in very much (30-60 for the overall
  45.     Mandelbrot picture) and higher values when you are zoomed in a lot
  46.     near Mandelbrot regions.
  47.  
  48.     Next you will be prompted for the X coordinate of the lower left
  49.     corner of the area you wish to view.  (This is really the real part
  50.     of the complex number.)  You can enter just a carriage return to
  51.     get the default coordinate for the overall Mandelbrot picture.
  52.  
  53.     Next you will be prompted for the Y coordinate of the lower left
  54.     corner of the area you wish to view.  (This is really the
  55.     imaginary part of the complex number.)  Again, you can enter just
  56.     a carriage return to get the default coordinate for the overall
  57.     Mandelbrot picture.
  58.  
  59.     Last, you will be prompted for the length of the side of the region
  60.     you wish to view.  Again, you can enter just a carriage return to
  61.     get the default for the overall Mandelbrot picture.  After you enter
  62.     this value, the program will switch to graphics mode and begin
  63.     displaying the Mandelbrot picture.
  64.  
  65.     While the picture is being generated, you can press the Q key to
  66.     quit.  The quit may not take affect immediately.  It will not take
  67.     affect until a curvetrace or fill, which is in progress, completes.
  68.     When it takes affect, you will see a menu of Key commands on the
  69.     left margin of your screen.
  70.  
  71.     When the picture generation has completed, a menu of options and
  72.     parameters will be displayed in the left margin of the screen.
  73.     Also, a cursor in the shape of an arrow will be displayed near the
  74.     upper left of the screen in the menu margin.  If you don't have a
  75.     mouse, you can move the cursor around by using the cursor keys on
  76.     the keyboard as well as the PgUp, PgDn and CTRL left and right arrow
  77.     keys for faster cursor movement.  See the key definition table below,
  78.     for details.
  79.  
  80.     If you have a mouse, the mouse will automatically be enabled after
  81.     the picture plotting is completed.  In this case you CAN NOT
  82.     use the keyboard keys to move the cursor around the screen.  The
  83.     left mouse button can also be used instead of the ENTER key to select
  84.     the same functions as the ENTER key would have. Zoom boxes
  85.     can only be resized by using the keyboard keys F9 and F10 (see key
  86.     definitions below).
  87.  
  88.     The following commands are available when the menu is displayed.
  89.     Note that not all of the commands are displayed in the menu margin.
  90.     This is because there was not enough room.  They can still be
  91.     used, however, whenever the menu is displayed.  Some of the
  92.     commands require user entry of parameters, such as a number or a
  93.     file name.  The prompt for the user entry will appear near the
  94.     center of the menu margin, with the user entered data appearing
  95.     on the next line.  Keys which have an (E) following them are
  96.     supported properly only in EGA mode.
  97.  
  98.     KEY        FUNCTION
  99.     ---        --------
  100.     C         Change the value of the maximum iteration count used
  101.             in computing the Mandelbrot set.  You will be prompted
  102.             for the new value.  Remember, the higher the maximum
  103.                 count value you select, the longer the picture will
  104.                 take to complete.  When you are not zoomed in very
  105.                 much (side lengths approx. < 10 E -3) values in the
  106.                 30 - 200 range are fine.  For side lengths approx.
  107.                 less than 10 E -6, near the black Mandelbrot regions,
  108.                 you may have to use values between 500 and 1000 in
  109.                 order to not see just a big black picture.
  110.             
  111.     L (E)    Load a saved picture from disk.  You will be prompted
  112.             for the filename to load.  DO NOT enter the extension.
  113.             Valid path names can be entered to load pictures from
  114.             other directories or other disk drives.
  115.             
  116.     I           Inspect.  This command will compute the value of the
  117.                 mandelbrot function at the location that the cursor is
  118.                 pointing to, and display the result in the left margin
  119.                 as "xxxx iterations", where xxxx is the number of
  120.                 iterations the function was evaluated before it was
  121.                 known to diverge at that point.  It is useful for
  122.                 determining an optimal value for the color offset
  123.                 variable (see command O).
  124.  
  125.     N         New coordinates.  You will be prompted for the coords.
  126.             and side length of a new region to view.
  127.             
  128.     O        Change color Offset.  This is used to get more colors
  129.             displayed on pictures where most or all of the colors
  130.             correspond to relatively high iteration counts.  The
  131.             colors correspond to ranges of iteration counts, where
  132.             the size of the range is equal to INT(max.count/15),
  133.                 since there are 15 colors not counting black.  By
  134.                 using the inspect command (see command I), you can
  135.                 determine an optimal value for the offset as follows:
  136.                 Move the cursor to a color region in the displayed
  137.                 Mandelbrot picture that is the same color as the lowest
  138.                 numbered color in the displayed color palette.  If this
  139.                 color palette number is already a 1, then the color
  140.                 offset value is already optimal.  If it is not a 1 then
  141.                 issue the "I" command to inspect the value of Mandelbrot
  142.                 at that point.  Try other points near the boundries of
  143.                 that color region to find the smallest iteration count
  144.                 in that color region.  Use the smallest number you can
  145.                 find for the color offset value.  You must then do a
  146.                 zoom operation over the entire Mandelbrot picture to
  147.                 get a new picture that will display all of the colors
  148.                 in the palette.
  149.             
  150.     Q        Quit back one level.  If the picture is being plotted,
  151.             quit may not take place immediately.  It will not take
  152.             place until a curve trace and its fill operation have
  153.             completed.  Then it will quit to the mandbrot menu, at
  154.             which point you can change any parameter.  You can even
  155.             do a zoom operation, including areas not yet plotted.
  156.             When the menu is active, the quit option causes a quit
  157.             back to DOS.
  158.             
  159.             You can also quit back to the mandbrot menu during a
  160.             zoom operation, while the zoom box is being displayed.
  161.  
  162.     R (E)    Rotate colors.  The color values in the color palette
  163.             will be rotated, creating a fascinating, flashy display.
  164.             It is interesting to note how the colors seem to flow
  165.             towards the black regions of the Mandelbrot set.
  166.             Press the up or down arrow keys to change the rate of
  167.             color rotation.  Press any alpha-numeric key to stop
  168.             rotation.
  169.             
  170.     S (E)    Save a picture to disk.  You will be prompted for a
  171.             filename to save.  DO NOT enter an extension.  Valid
  172.             path names can be entered to save pictures to other
  173.             directories or other disk drives.  Be sure to keep
  174.             the path names short enough to not extend into the
  175.             picture area, otherwise part of the name will become
  176.             part of the saved picture.  The picture will be saved
  177.             in 5 files, as follows:
  178.                  filename.PRM     Parameter values for picture
  179.                  filename.000     Color plane 0 picture data
  180.                  filename.001     Color plane 1 picture data
  181.                  filename.002     Color plane 2 picture data
  182.                  filename 003     Color plane 3 picture data
  183.  
  184.     T        Toggle the curvetrace mode ON/OFF.  The current status
  185.                 of the trace feature is displayed above the palette
  186.                 display.
  187.             
  188.     arrow    The arrow keys are used to move the cursor around the
  189.     keys    screen at the rate of one pixel per key press.
  190.  
  191.     CTRL    Fast cursor left and right move.
  192.     left &
  193.     right
  194.     arrow
  195.  
  196.     PgUp    Move cursor up fast.
  197.  
  198.     PgDn    Move cursor down fast.
  199.  
  200.     F9          Make zoom box a little smaller. (see also, ENTER)
  201.  
  202.     Shift F9    Make zoom box a lot smaller. (see also, ENTER)
  203.  
  204.     F10         Make zoom box a little bigger. (see also, ENTER)
  205.  
  206.     Shift F10   Make zoom box a lot bigger. (see also, ENTER)
  207.  
  208.     ENTER    Enter serves two functions.  You may move the cursor to
  209.             point to any of the numbers displayed in the palette
  210.             table.  When ENTER is pressed, the color being pointed
  211.             to will be enabled for changing.  Use the up/down or
  212.             right/left keys to change that color.  When you decide
  213.             on a color, press ENTER to lock-in that color.  You may
  214.             then point to another color to change, in the same manner.
  215.             
  216.             The other function of ENTER is to zoom in on an area of
  217.             the displayed picture.  The cursor MUST be in the picture
  218.             area for this function to work.  When ENTER is pressed, a
  219.             box with shifty borders will be drawn.  You can now move
  220.             the box around or resize it.  Move it around fast or slow
  221.             by use of the same keys that move the cursor fast or slow.
  222.             Resize the box by using the F9 and F10 keys.  F9 makes the
  223.             box a little smaller, SHIFT F9 makes the box a lot smaller.
  224.             F10 makes the box a little bigger, and SHIFT F10 makes the
  225.             box a lot bigger.  The size of the box is always properly
  226.             scaled to show the exact area you will be zooming in on.
  227.             When you are through selecting the area you want to zoom
  228.             in on, press ENTER again.  The new region will now be
  229.             computed and drawn.  If you wish to cancel the zoom
  230.             operation and return to the menu, press Q instead of the
  231.             second ENTER.
  232.             
  233.             Zooming is possible in CGA mode, but the box drawing
  234.             function works different in CGA mode.  In EGA mode the
  235.                 lines are XOR'd on the screen, thus making it possible
  236.                 to restore the original pixel values by just drawing the
  237.                 box again.  In CGA mode however, the lines are not XOR'd
  238.                 on the screen.  They are just put there, making it impossible
  239.                 to restore the original picture without additional
  240.                 programming.  The result is that the zoom boxes are left on
  241.                 the screen in CGA mode.  The zoom operation will still work
  242.                 though.
  243.  
  244.     Left        Same as ENTER.
  245.     mouse
  246.     button
  247.     
  248.     mouse       If a mouse is connected and the mouse driver is resident
  249.     movement    then the mouse can be used to move the cursor and zoom
  250.                 boxes around the screen.